Add notebook guidelines #316
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #316 +/- ##
=======================================
Coverage 91.78% 91.78%
=======================================
Files 43 43
Lines 2324 2324
=======================================
Hits 2133 2133
Misses 191 191
Flags with carried forward coverage won't be shown. Click here to find out more. 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
bkmartinjr
approved these changes
Mar 30, 2023
atolopko-czi
approved these changes
Mar 30, 2023
There was a problem hiding this comment.
LGTM, with a few typos to correct.
Should this also specify:
- Results should be run/rendered in the notebook
- Notebooks should be runnable on instances of type T (CPU/mem), not taking more than M minutes.
- Code formatting must pass lint requirements (we get this automatically, but still, it's a policy)
- Python version min/max
- Must only use packages listed requirements-notebooks.txt
Co-authored-by: Andrew Tolopko <[email protected]>
Co-authored-by: Andrew Tolopko <[email protected]>
Co-authored-by: Andrew Tolopko <[email protected]>
These will live in doc-site and should mainly be accessed through doc-site, no user-facing docs should link to the notebooks in the repo. Adding the doc-site link will be redundant |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a document with a set of editorial guidelines for notebooks (python) and vignettes (R).
An audit of the existing assets must follow upon approval of this PR.